Skip to main content

DescribeWebPath

Description

get the web directory definition information in the website backdoor settings.

Request Method

POST

Request Path

/apsara/route/aegis/DescribeWebPath

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
TypeBODYstringNoNo sample value for this parameter.configuration type, system-specified parameters. Value: web_path, indicating the configuration of the Web directory definition.
PageSizeBODYintegerNoNo sample value for this parameter.specifies the maximum number of records per page in the returned result. default value: 20
CurrentPageBODYintegerNoNo sample value for this parameter.specifies the number of pages currently returned. default value: 1
regionIdBODYstringYesNo sample value for this parameter.region id
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
TargetListarrayno demo valuethe list of target hosts to which the web directory path is applied. see the following parameter description for specific sub-items.
TotalCountintegerno demo valuetotal number of records returned.
Targetstringno demo valuehost asset UUID.
RequestIdstringno demo valuerequest ID.
PageSizeintegerno demo valuepage displays the maximum number of records.
CurrentPageintegerno demo valuecurrently returns page number.
TargetTypestringno demo valuethe fixed return value is uuid, indicating that the value of the Target parameter is the host asset UUID.
Countintegerno demo valuenumber of Web directory configuration records.
WebPathstringno demo valueWeb directory path.
ConfigListarrayno demo valueWeb directory list, see the following parameter description for specific sub-items.

Example

Successful Response example

{
"TargetList":"no demo value",
"TotalCount":"no demo value",
"Target":"no demo value",
"RequestId":"no demo value",
"PageSize":"no demo value",
"CurrentPage":"no demo value",
"TargetType":"no demo value",
"Count":"no demo value",
"WebPath":"no demo value",
"ConfigList":"no demo value"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}